'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH STMFDEVIDFROMISCSINAME 3STMF "Jun 9, 2008"
.SH NAME
stmfDevidFromIscsiName \- convert an iSCSI name to a stmfDevid structure
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
#include <libstmf.h>

\fBint\fR \fBstmfDevidFromIscsiName\fR(\fBchar *\fR\fIiscsiName\fR, \fBstmfDevid *\fR\fIdevid\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIiscsiName\fR\fR
.ad
.RS 13n
A character string of UTF-8 encoded Unicode characters representing the iSCSI
name terminated with the Unicode nul character.
.RE

.sp
.ne 2
.na
\fB\fIdevid\fR\fR
.ad
.RS 13n
A pointer to a \fBstmfDevid\fR structure allocated by the caller. On successful
return, this will contain the converted device identifier. On error, the value
of this parameter is undefined.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBstmfDevidFromIscsiName()\fR function converts an iSCSI name to a
\fBstmfDevid\fR structure. It returns the \fIdevid\fR as a SCSI name string
identifier.
.SH RETURN VALUES
.sp
.LP
The following values are returned:
.sp
.ne 2
.na
\fB\fBSTMF_ERROR_INVALID_ARGUMENT\fR\fR
.ad
.sp .6
.RS 4n
The value of \fIiscsiName\fR was not valid iSCSI name.
.RE

.sp
.ne 2
.na
\fB\fBSTMF_STATUS_SUCCESS\fR\fR
.ad
.sp .6
.RS 4n
The API call was successful.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Committed
_
MT-Level	Safe
.TE

.SH SEE ALSO
.sp
.LP
.BR libstmf (3LIB),
.BR attributes (7)
